Skip to content

Add docs API diagrams and site updates#159

Open
chloecrozier wants to merge 1 commit into
mainfrom
docs/api-diagrams
Open

Add docs API diagrams and site updates#159
chloecrozier wants to merge 1 commit into
mainfrom
docs/api-diagrams

Conversation

@chloecrozier

@chloecrozier chloecrozier commented Jun 12, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Summary

  • Add Pillow GIF animations for HDS, flow steering, and packet reorder
  • Share RX wire rendering via incoming_wire.py (wavy lines, labeled in-flight packets)
  • Broader docs/site work on this branch: API reference reorg, benchmarks, tutorials, metrics, and examples
  • Made sure to create both light/dark versions

Examples

HDS

image

Flow Steering

image

image

Test plan

  • Open GIFs under docs/images/packet_diagrams/{hds,flow_steering,reorder}/
  • Regenerate: python3 docs/images/packet_diagrams/*_animation.py
  • mkdocs serve and spot-check docs pages

@chloecrozier chloecrozier requested a review from dleshchev June 12, 2026 07:09
@greptile-apps

greptile-apps Bot commented Jun 12, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Greptile Summary

Adds Pillow-based GIF animation scripts for three RX path concepts (header-data split, flow steering, and packet reorder), a shared incoming_wire.py module for wavy wire rendering, and the corresponding dark/light output images. The .gitignore is extended to cover __pycache__/.

  • Three new standalone Python scripts generate multi-frame GIFs and poster PNGs for docs; wire drawing and arc-length path logic are factored into incoming_wire.py and reused across all three.
  • hds_animation.py's rgba_frame_to_palette uses local variables named rgba and rgb, shadowing the module-level helpers of the same name — unlike flow_steering_animation.py and reorder_animation.py which use rgba_img/rgb_img.
  • The squashed commit title (docs: add HDS, flow steering, and reorder packet animations) does not follow the required #<Issue Number> - <Title> format, and no GitHub issue is referenced in the PR description.

Confidence Score: 5/5

Docs-only change adding Python animation scripts and generated GIFs; no library code, API surface, or build system is touched.

All changed files are documentation assets and standalone image-generation scripts. The library source, CMake build, and public API are untouched, so there is no risk to runtime behaviour.

docs/images/packet_diagrams/hds_animation.py — minor naming inconsistency in rgba_frame_to_palette worth fixing for consistency with the other two animation files.

Important Files Changed

Filename Overview
docs/images/packet_diagrams/incoming_wire.py New shared module exporting wavy wire drawing, packet markers, and arc-length path helpers; clean and consistent with callers.
docs/images/packet_diagrams/flow_steering_animation.py New flow-steering GIF generator; consistent helper naming (rgba_img/rgb_img) and correct dual-theme rendering loop.
docs/images/packet_diagrams/hds_animation.py New HDS GIF generator; rgba_frame_to_palette uses local variables named rgba/rgb that shadow the module-level helper functions, inconsistent with the other two animation files.
docs/images/packet_diagrams/reorder_animation.py New reorder GIF generator; commit title does not follow the required # - <Title> format.
.gitignore Adds pycache/ entry; appropriate for newly added Python scripts.

Reviews (4): Last reviewed commit: "docs: add HDS, flow steering, and reorde..." | Re-trigger Greptile

greptile-apps[bot]
greptile-apps Bot reviewed Jun 12, 2026
View reviewed changes
Comment thread docs/images/packet_diagrams/reorder_animation.py
Comment thread docs/images/packet_diagrams/flow_steering_animation.py
@chloecrozier
docs: add HDS, flow steering, and reorder packet animations
7e6940f 
Add Pillow GIF generators for header-data split, flow steering, and GPU
reorder. Share RX wire rendering via incoming_wire.py (wavy lines,
labeled in-flight packets, dark/light themes).

Signed-off-by: Chloe Crozier <chloecrozier@gmail.com>
dleshchev added a commit that referenced this pull request Jun 15, 2026
@dleshchev
#159 - Convert packet diagrams to WebP
9100e18 
Signed-off-by: dleshchev <dleshchev@nvidia.com>
dleshchev added a commit that referenced this pull request Jun 15, 2026
@dleshchev
#159 - Check packet diagram reproducibility
beda551 
Signed-off-by: dleshchev <dleshchev@nvidia.com>
dleshchev added a commit that referenced this pull request Jun 15, 2026
@dleshchev
#159 - Document packet diagram size notes
5f50ee4 
Signed-off-by: dleshchev <dleshchev@nvidia.com>
dleshchev added a commit that referenced this pull request Jun 15, 2026
@dleshchev
#159 - Clean up packet diagram animations
e2583ce 
Signed-off-by: dleshchev <dleshchev@nvidia.com>
dleshchev added a commit that referenced this pull request Jun 15, 2026
@dleshchev
#159 - Align packet diagram motion paths
a684025 
Signed-off-by: dleshchev <dleshchev@nvidia.com>
dleshchev added a commit that referenced this pull request Jun 15, 2026
@dleshchev
#159 - Polish packet diagram layout
8ebd00c 
Signed-off-by: dleshchev <dleshchev@nvidia.com>
dleshchev added a commit that referenced this pull request Jun 15, 2026
@dleshchev
#159 - Refine packet diagram motion
f8ee57e 
Signed-off-by: dleshchev <dleshchev@nvidia.com>
dleshchev added a commit that referenced this pull request Jun 15, 2026
@dleshchev
#159 - Refine packet diagram labels
d2b6172 
Signed-off-by: dleshchev <dleshchev@nvidia.com>
dleshchev added a commit that referenced this pull request Jun 15, 2026
@dleshchev
#159 - Smooth packet diagram timing
a270a8b 
Signed-off-by: dleshchev <dleshchev@nvidia.com>
dleshchev added a commit that referenced this pull request Jun 15, 2026
@dleshchev
#159 - Refine packet diagram labels
637361b 
Signed-off-by: dleshchev <dleshchev@nvidia.com>
dleshchev added a commit that referenced this pull request Jun 15, 2026
@dleshchev
#159 - Polish packet diagram motion
2927b57 
Signed-off-by: dleshchev <dleshchev@nvidia.com>
dleshchev added a commit that referenced this pull request Jun 16, 2026
@dleshchev
#159 - Enlarge packet diagram NIC status boxes
7409fe0 
Signed-off-by: dleshchev <dleshchev@nvidia.com>
dleshchev added a commit that referenced this pull request Jun 16, 2026
@dleshchev
#159 - Grow packet diagram NIC chips
e7d0b27 
Signed-off-by: dleshchev <dleshchev@nvidia.com>
dleshchev added a commit that referenced this pull request Jun 16, 2026
@dleshchev
#159 - Center packet diagram NIC status boxes
fed8761 
Signed-off-by: dleshchev <dleshchev@nvidia.com>
dleshchev added a commit that referenced this pull request Jun 16, 2026
@dleshchev
#159 - Add packet diagram animations
b0ad17d 
Signed-off-by: dleshchev <dleshchev@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@greptile-apps greptile-apps[bot] greptile-apps[bot] left review comments
@dleshchev dleshchev Awaiting requested review from dleshchev

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@chloecrozier